﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class SECSItemFactory
 </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class SECSItemFactory
 ">
  
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
  
  
  
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../../index.html">
                <img id="logo" class="svg" src="../../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemFactory">


  <h1 id="com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemFactory" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemFactory" class="text-break">Class SECSItemFactory
</h1>
  <div class="markdown level0 summary"><p>This is a static &quot;factory&quot; class that is used to create a
<code>SECSItem</code> object from a <code>byte[]</code> that is in &quot;wire/transmission&quot; form.
As you might expect the
bytes contained within the <code>byte[]</code> must actually be in the form
of those of an item in a SECS-II message.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">SECSItemFactory</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.html">com.CIMthetics.CSharpSECSTools.SECSItems</a></h6>
  <h6><strong>Assembly</strong>: SECSItems.dll</h6>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemFactory_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static class SECSItemFactory</code></pre>
  </div>
  <h3 id="methods">Methods
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemFactory_GenerateSECSItem_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemFactory.GenerateSECSItem*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemFactory_GenerateSECSItem_System_Byte___System_Int32_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemFactory.GenerateSECSItem(System.Byte[],System.Int32)">GenerateSECSItem(Byte[], Int32)</h4>
  <div class="markdown level1 summary"><p>Generates a <code>SECSItem</code> object from the <code>byte[]</code> that is passed to it.
The parameter <code data-dev-comment-type="paramref" class="paramref">offset</code> specifies an offset into the supplied
<code>byte[]</code> where the data for the <code>SECSItem</code> starts.
The data in the <code>byte[]</code> needs to be in &quot;wire/transmission&quot; format.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static SECSItem GenerateSECSItem(byte[] data, int offset)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><span class="parametername">data</span></td>
        <td><p>An array of bytes that is in wire/transmission format.</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">offset</span></td>
        <td><p>The byte offset into <code>data</code> where the data for
a <code>SECSITEM</code> starts.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html">SECSItem</a></td>
        <td><p>The resulting <code>SECSItem</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemFactory_GenerateSECSItem_System_Byte___System_Int32__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>This would be the desired method to use in the case where the <code>byte[]</code>
also contains the header for a SECs message (located at the beginning of the
<code>byte[]</code>).  In this situation, since a SECS message header is
10 bytes in length you would pass 10 in as the value of the <code data-dev-comment-type="paramref" class="paramref">offset</code>
parameter.  This will cause this method to skip the first 10 bytes of the
<code>byte[]</code> and extract / generate the <code>SECSItem</code> from the remaining bytes.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemFactory_GenerateSECSItem_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemFactory.GenerateSECSItem*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemFactory_GenerateSECSItem_System_Byte___" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemFactory.GenerateSECSItem(System.Byte[])">GenerateSECSItem(Byte[])</h4>
  <div class="markdown level1 summary"><p>Generates a <code>SECSItem</code> object from the <code>byte[]</code> that is passed to it
starting with byte 0 of the <code>byte[]</code>.
The data in the <code>byte[]</code> needs to be in &quot;wire/transmission&quot; format.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static SECSItem GenerateSECSItem(byte[] data)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><span class="parametername">data</span></td>
        <td><p>An array of bytes that is in wire/transmission format.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html">SECSItem</a></td>
        <td><p>The resulting <code>SECSItem</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
